home *** CD-ROM | disk | FTP | other *** search
/ Compendium Deluxe 1 / LSD Compendium Deluxe 1.iso / a / text / manipulation / text2200.lha / text2guide / Text2Guide.doc < prev    next >
Encoding:
Text File  |  1993-08-22  |  5.3 KB  |  192 lines
  1. Document Text2Guide Release 02.00 documentation
  2.  
  3.             Text2Guide Program Guide
  4.             ~~~~~~~~~~~~~~~~~~~~~~~~
  5.  
  6.           Release 02.00 © Stephan Sürken 1993
  7.  
  8.             Finished 22 Aug 1993
  9.  
  10. 0. Important
  11. =============
  12.  
  13. 0.1. Copyright & legal stuff
  14. -----------------------------
  15.  
  16.  Text2Guide    02.XX is © Stephan Sürken 1993.
  17.  
  18.  Text2Guide is PUBLIC DOMAIN, that means you may copy and use it freely.
  19.  
  20.  For any comments, bug reports or similar stuff, contact me (see
  21.  `The Author').
  22.  
  23.  Note the following:
  24.  
  25.   o If you copy it, you MUST copy the whole original archive.
  26.   o You may include this copy on any Public Domain Series, but you
  27.     MUST NOT include it on any disk that is selled for more than
  28.     5 US Dollar (or an equivalent in other currencies).
  29.   o The program must neither be used nor copied by any right wing
  30.     organisations or persons.
  31.  
  32. 0.2. Release Notes
  33. -------------------
  34.  
  35.  Release: Text2Guide 02.00
  36.  ~~~~~~~~~~~~~~~~~~~~~~~~~
  37.  
  38.  This version is an update to version 01.00, that was included
  39.  in the VideoMaxe Release 04.12.
  40.  
  41.  Additionally features:
  42.  
  43.  o improved whole program structure...
  44.  o can now convert links in texts
  45.  o multiple node test
  46.  o cli options
  47.  
  48.  
  49. 1. Introduction
  50. ================
  51.  
  52.  After searching for a progam of this kind in various ftp nets for
  53.  quite a time (without success), I decided to write it myself.
  54.  
  55.  Here it is!
  56.  
  57.  
  58. 2. Documentation
  59. =================
  60.  
  61.   Text2Guide converts plain ASCII text into AmigaGuide (c) format.
  62.  Sticking to some simple organisation of the text file one can
  63.  simply realize a well structured guide file while still having
  64.  a well readable text file at hand.
  65.  
  66. 2.1. Startup
  67. -------------
  68.  
  69.  Text2Guide is a CLI-Tool. Type Text2Guide and you`ll get:
  70.  
  71.  ---
  72.  Text2Guide 02.00 (22 Aug 1993) © Stephan Sürken
  73.  
  74.  Failed: Can`t open input text file!
  75.  
  76.  SYNTAX: Text2Guide <text_file> <guide_file> {+-uwt}
  77.  
  78.  u: ignore underline of units, default on.
  79.  w: out warnings,              default on.
  80.  t: perform node test,         default on.
  81.  ---
  82.  
  83.  That`s rather self-explaining, is it not??
  84.  
  85.  See `Options' for exact meaning of the options.
  86.  
  87.  Note that <guide_file> automatically is removed if existent.
  88.  
  89. 2.2. Text file organization
  90. ----------------------------
  91.  
  92.  There are following rules for the text file:
  93.  
  94.  o The document starts with the keyword "Document" at the beginning
  95.    of a line. The rest of this line will be taken as name of the
  96.    AmigaGuide database.
  97.    In the document you are reading this is in the first line (where
  98.    it normally should be).
  99.  
  100.  o You have to divide your text document in units. These units must
  101.    start at the beginning of a line, and consist of arabic numbers
  102.    divided by dots. Whole hierarchical relations are recognized.
  103.    The rest of the line after this unit number will be taken as
  104.    title of this unit.
  105.    Examples:
  106.        
  107.        1. Einleitung            -> unit number "1",
  108.                           title is "Einleitung"
  109.         4.2.1. Das Spiel beginnen    -> unit number "4 2 1",
  110.                            title is "Das Spiel beginnen"
  111.  
  112.  o Lines that are neither the first document line nor start with
  113.    a unit number are texts. In texts, there may be links to other
  114.    units, e.g. like `Test Link'. Such links start with an 
  115.    "`"-character and end with an
  116.    "'"-character, containing the title of the required unit. Such
  117.    links must be in one line.
  118.    
  119.  
  120.   Example: Please look at this document as example!
  121.   ~~~~~~~~
  122.  
  123. 2.2.1. Test Link
  124. ---------------
  125.  
  126.  You have clicked on the test link, so you are now in this chapter.
  127.  Simply retrace or click `Text file organization' to get back.
  128.  
  129. 2.3. Options
  130. -------------
  131.  
  132.  These options can be supplied to Text2Guide as arguments after
  133.  the input and output file name. "-" will put off an option,
  134.  "+" will put it on.
  135.  
  136.  Option u: ignore underline lines, default on.
  137.  ~~~~~~~~~
  138.      If this option is on, lines directly following to lines
  139.      with unit numbers are ignored. That is to let you 
  140.      underline such units in the plain text file.
  141.      
  142.      For example this unit is defined in the text file by
  143.      these two lines:
  144.      
  145.      2.3. Options
  146.         -------------
  147.         
  148.         If option u would be off, you would see the "-------------"
  149.         at the top of the window in the guide document...
  150.  
  151.  Option w: out warnings, default on.
  152.  ~~~~~~~~~
  153.      If this option is on, warnings are written, else not.
  154.      You should normally not put this off.
  155.      
  156.  Option t: test for multiple nodes, default on.
  157.  ~~~~~~~~~
  158.      If this option is on, Text2Guide will perform a test for
  159.      multiple defined nodes (->units) after transforming, and
  160.      produce warnings if multiple nodes are found.
  161.      Note that with "t" on and "w" off the test will be 
  162.      performed but no warnings written.
  163.      
  164.  
  165.  Example: Text2Guide Text2Guide.doc Text2Guide.guide -wt +u
  166.  ~~~~~~~~
  167.     This will recompile this document; no warnings will
  168.     be written and not multiple node test will be 
  169.     performed; underlines of units will be omitted (though
  170.     "+o" is obsolete as the default is on).
  171.  
  172.  
  173. 3. The Author
  174. ==============
  175.  
  176.  The author is me and I am the author.
  177.  
  178.  Send your enthusiastic mails to:
  179.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  180.  o Address:    Stephan Sürken
  181.          Kurt-Schumacher-Str. 34 A 161
  182.          D-67663 Kaiserslautern
  183.  
  184.  o E-Mail:    s_suerke@informatik.uni-kl.de
  185.  
  186.  Please send much money to:
  187.  ~~~~~~~~~~~~~~~~~~~~~~~~~~
  188.  o Bank account:Stadtsparkasse Kaiserslautern, FRG
  189.  
  190.         BLZ: 540 501 10        identity of bank in germany
  191.         KTO: 128 029 758    number of my bank account
  192.